/* ***** BEGIN LICENSE BLOCK *****
   Version: Apache 2.0/GPL 3.0/LGPL 3.0

   CCT - Computational Chemistry Tools
   JMolEditor - Java Molecules Editor

   Copyright 2008 Dr. Vladislav Vasilyev

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

   Contributor(s):
     Dr. Vladislav Vasilyev <vvv900@gmail.com>       (original author)

  Alternatively, the contents of this file may be used under the terms of
  either the GNU General Public License Version 2 or later (the "GPL"), or
  the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  in which case the provisions of the GPL or the LGPL are applicable instead
  of those above. If you wish to allow use of your version of this file only
  under the terms of either the GPL or the LGPL, and not to allow others to
  use your version of this file under the terms of the Apache 2.0, indicate your
  decision by deleting the provisions above and replace them with the notice
  and other provisions required by the GPL or the LGPL. If you do not delete
  the provisions above, a recipient may use your version of this file under
  the terms of any one of the Apache 2.0, the GPL or the LGPL.

 ***** END LICENSE BLOCK *****/

package cct.grid;

import java.util.HashMap;
import java.util.Map;

/**
 * <p>Title: Molecular Structure Viewer/Editor</p>
 *
 * <p>Description: Computational Chemistry Toolkit</p>
 *
 * <p>Copyright: Copyright (c) 2006</p>
 *
 * <p>Company: ANU</p>
 *
 * @author Dr. V. Vasilyev
 * @version 1.0
 */
public interface CheckPointInterface {
  final static int PARSE_TASK_TAGS = 1;
  final static int PARSE_SERVICE_TAGS = 2;
  final static int PARSE_JOB_SPECIFICATION_TAGS = 3;
  final static int PARSE_OUTPUT_FILES_TAGS = 4;

  final static String JOB_STATUS_DONE = "DONE";
  final static String JOB_STATUS_PENDING = "PENDING";
  final static String JOB_STATUS_UNKNOWN = "UNKNOWN";

  //final static String serviceEntriesTag = "serviceTags";
  //final static String jobSpecificationEntriesTag = "jobSpecificationTags";
  //final static String outputFilesEntriesTag = "outputFilesTags";

  final static String tasksTag = "tasks";
  final static String taskTag = "task";
  final static String jobNameTag = "jobName";
  final static String serviceTag = "service";
  final static String handleTag = "handle";
  final static String providerTag = "provider";
  final static String computerTag = "computer";
  final static String softwareTag = "software";
  final static String programTag = "program";
  final static String JobSpecificationTag = "JobSpecification";
  final static String executableTag = "executable";
  final static String localExecutableTag = "localExecutable";
  final static String stdOutputTag = "stdOutput";
  final static String stdErrorTag = "stdError";
  final static String batchJobTag = "batchJob";
  final static String remoteDirectoryTag = "remoteDirectory";
  final static String localDirectoryTag = "localDirectory";
  final static String outputFilesTag = "outputFiles";
  final static String inputFilesTag = "inputFiles";
  final static String statusTag = "status";
  final static String overallJobStatusTag = "jobStatus";
  final static String submittedTimeTag = "submittedTime";

  // Some specific tags

  final static Map firstLevelTags = new HashMap();
  final static Map serviceTags = new HashMap();
  final static Map JobSpecificationTags = new HashMap();

  // --- member functions

  void setOutputFile(String tag, String value) throws Exception;

  void setServiceTag(String tag, String value, boolean overwrite) throws Exception;
}
